home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / dejagnu.lha / dejagnu-1.0.1 / tcl / doc / Backslash.3 < prev    next >
Text File  |  1993-02-14  |  2KB  |  56 lines
  1. '\"
  2. '\" Copyright 1989 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. .so man.macros
  11. .HS Tcl_Backslash tcl
  12. .BS
  13. .SH NAME
  14. Tcl_Backslash \- parse a backslash sequence
  15. .SH SYNOPSIS
  16. .nf
  17. \fB#include <tcl.h>\fR
  18. .sp
  19. char
  20. \fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
  21. .SH ARGUMENTS
  22. .AS char *countPtr
  23. .AP char *src in
  24. Pointer to a string starting with a backslash.
  25. .AP int *countPtr out
  26. If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
  27. in with number of characters in the backslash sequence, including
  28. the backslash character.
  29. .BE
  30.  
  31. .SH DESCRIPTION
  32. .PP
  33. This is a utility procedure used by several of the Tcl
  34. commands.  It parses a backslash sequence and returns
  35. the single character corresponding to the sequence.
  36. .VS
  37. If the backslash sequence should be replaced by no character
  38. at all (e.g. backslash-newline) then \fBTcl_Backslash\fR returns 0.
  39. .VE
  40. \fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number
  41. of characters in the backslash sequence.
  42. If \fIsrc\fR doesn't point to a backslash
  43. sequence understood by Tcl, then Tcl_Backslash returns a backslash
  44. as its result and \fI*countPtr\fR gets set to 1 (in this case the
  45. backslash character should not get any special treatment).
  46. .PP
  47. See the Tcl manual entry for information on the valid
  48. backslash sequences.
  49. .VS
  50. All of the sequences described in the Tcl
  51. manual entry are supported by \fBTcl_Backslash\fR.
  52. .VE
  53.  
  54. .SH KEYWORDS
  55. backslash, parse
  56.